Upgrade to v0.2.0 by rsoury · Pull Request #27 · usherlabs/cex-broker

rsoury · 2026-02-19T04:13:35Z

Summary by CodeRabbit

Release Notes

New Features
- Policy configuration now supports multiple per-exchange, per-network withdraw rules with intelligent prioritization.
- Enhanced order validation with market pattern matching and execution resolution.
- OpenTelemetry logging integration via LogLayer framework.
- Dev container initialization for git worktree support.
Documentation
- Added comprehensive POLICY.md guide.
- Updated README with new policy structure examples.
Chores
- Version bumped to 0.2.0.
- Updated dependencies including OpenTelemetry stack and LogLayer packages.

…stments - Added an initialization script (.devcontainer/init.sh) to determine the main repository path when in a git worktree. - Updated docker-compose.yml to include a volume workaround for accessing the main repo path. - Set the entrypoint script (.devcontainer/entrypoint.sh) to be executable. - Included an initializeCommand in devcontainer.json to run the new script on container startup.

Upgrade Policy Engine and JSON Format. Improve Otel for log shipping

coderabbitai · 2026-02-19T04:13:55Z

Caution

Review failed

The pull request is closed.

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between c85517a and 3a6d014.

⛔ Files ignored due to path filters (1)

bun.lock is excluded by !**/*.lock

📒 Files selected for processing (25)

.devcontainer/devcontainer.json
.devcontainer/docker-compose.yml
.devcontainer/init.sh
.sandbox/Dockerfile
POLICY.md
README.md
biome.json
examples/kraken-orderbook-demo.ts
package.json
policy/policy.json
scripts/gen-descriptor.ts
src/client.dev.ts
src/helpers/index.test.ts
src/helpers/index.ts
src/helpers/logger.ts
src/helpers/otel.ts
src/index.ts
src/server.ts
src/types.ts
test/cex-broker.test.ts
test/helpers.test.ts
test/index.test.ts
test/integration.test.ts
test/otel.test.ts
test/start-broker.test.ts

Walkthrough

This PR restructures policy validation from a single withdraw rule to an array of exchange/network-scoped rules, introduces OpenTelemetry logging via LogLayer with multiple transports, adds market pattern matching and order execution resolution logic, and expands test coverage significantly.

Changes

Cohort / File(s)	Summary
Dev Container & Initialization `.devcontainer/devcontainer.json`, `.devcontainer/docker-compose.yml`, `.devcontainer/init.sh`, `.sandbox/Dockerfile`	Added dev container initialization script to detect git worktrees and propagate MAIN_REPO environment variable; updated Dockerfile to bump cex-broker package version from 0.1.21 to 0.2.0.
Documentation `POLICY.md`, `README.md`	Added comprehensive POLICY.md reference documentation for policy.json configuration, validation rules, and hot-reload behavior; updated README with new array-based rule policy structure examples and removed legacy composite amounts/networks format.
Configuration `biome.json`, `package.json`	Added experimental scanner ignore pattern for proto files; bumped version to 0.2.0 and added OpenTelemetry logging dependencies (`@loglayer/`\*, `@opentelemetry/api-logs`, `@opentelemetry/exporter-logs-otlp-http`, `@opentelemetry/sdk-logs`) plus loglayer and serialize-error packages.
Policy Types & Schema `src/types.ts`, `policy/policy.json`	Refactored WithdrawRule to WithdrawRuleEntry with exchange and network fields; changed PolicyConfig.withdraw.rule from single object to array of entries; made OrderRule.limits optional; updated example policy.json to use discrete per-exchange rules.
Policy Validation & Helpers `src/helpers/index.ts`	Implemented exchange/network-scoped withdraw rule prioritization; added market pattern matching and resolveOrderExecution for market symbol/side resolution; enhanced policy normalization and error handling; updated validateWithdraw signature to include exchange parameter.
Logger & Telemetry `src/helpers/logger.ts`, `src/helpers/otel.ts`	Refactored logger to use LogLayer with TsLog and OpenTelemetry transports; introduced BaseOtelSignal base class for metrics and logs providers; added OtelLogs class with OTLP support; implemented endpoint resolution and configuration utilities.
Server & Application Lifecycle `src/index.ts`, `src/server.ts`	Integrated OtelLogs lifecycle management alongside OtelMetrics; replaced inline validateOrder calls with resolveOrderExecution for market validation; updated withdraw validation to pass exchange parameter; adjusted order creation to use resolved symbol and side.
Test Suite `test/helpers.test.ts`, `test/cex-broker.test.ts`, `test/integration.test.ts`, `test/index.test.ts`, `test/otel.test.ts`, `test/start-broker.test.ts`, `src/helpers/index.test.ts`	Replaced deleted src/helpers/index.test.ts with comprehensive test/helpers.test.ts covering loadPolicy, validateWithdraw/Order/Deposit, and resolveOrderExecution; updated existing test files to reflect new policy structure and validateWithdraw signature; minor import reordering in various test files.
Minor Updates `examples/kraken-orderbook-demo.ts`, `scripts/gen-descriptor.ts`, `src/client.dev.ts`	Consolidated duplicate imports, reordered import statements, and added dotenv configuration loading.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Server
    participant Helpers
    participant Exchange
    participant OtelLogs

    Client->>Server: CreateOrder request
    Server->>Helpers: resolveOrderExecution(policy, broker, cex, ...)
    
    Helpers->>Helpers: Match market patterns<br/>against policy rules
    Helpers->>Exchange: Check symbol support<br/>(direct & reverse)
    Exchange-->>Helpers: Symbol availability
    
    Helpers->>Helpers: Resolve symbol & side<br/>Apply conversion limits
    Helpers-->>Server: OrderExecutionResolution<br/>(symbol, side, amountBase)
    
    alt Resolution valid
        Server->>Exchange: Execute order<br/>with resolved params
        Exchange-->>Server: Order confirmation
        Server->>OtelLogs: Emit order event
    else Resolution invalid
        Server-->>Client: INVALID_ARGUMENT error
    end
    
    Server-->>Client: Order response

sequenceDiagram
    participant Application
    participant LogLayer
    participant TsLogTransport
    participant OTelTransport
    participant Outputs

    Application->>LogLayer: log.info(message)
    
    LogLayer->>TsLogTransport: Forward log record
    LogLayer->>OTelTransport: Forward log record<br/>(if NODE_ENV != test)
    
    TsLogTransport->>Outputs: Console/File output
    OTelTransport->>Outputs: OTLP HTTP endpoint
    
    Note over LogLayer: serializeError() for<br/>error objects

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~60 minutes

Possibly related PRs

PR #24: Introduces initial OpenTelemetry integration changes (OtelMetrics, OtelConfig) that are extended in this PR with OtelLogs and BaseOtelSignal refactoring.
PR #26: Contains overlapping code-level changes to policy validation (WithdrawRuleEntry, validateWithdraw signature, resolveOrderExecution) and telemetry integration requiring coordination.

Suggested reviewers

victorshevtsov

🐰 Whiskers twitch with glee

Rules in arrays, patterns that dance,
Logs flow freely through transport's trance,
Orders execute with wisdom refined,
Policy patterns perfectly aligned,
A telemetry feast—quite the advance! ✨

✨ Finishing Touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch develop

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

victorshevtsov and others added 11 commits February 4, 2026 08:46

improve the policy order rules

cbf69a2

improve otel to ship logs via loglayer

123c9e3

upgrade the withdraw policy mechanic to be per exchange

14c5c51

format

999b2d0

resolve pr comments

fcc36bb

improve POLICY.md document

f2237c4

remove withdrawal amounts min/max - as theyre pointless

039d2f9

export policy config

f703226

pr comment

ebab756

Merge pull request #26 from usherlabs/feat/fiet-593

3a6d014

Upgrade Policy Engine and JSON Format. Improve Otel for log shipping

rsoury merged commit c121488 into master Feb 19, 2026
4 of 5 checks passed

coderabbitai Bot mentioned this pull request Mar 26, 2026

Add deposit policy enforcement and coin-based withdrawal constraints #35

Merged

coderabbitai Bot mentioned this pull request May 14, 2026

feat: capture CEX order execution telemetry #41

Merged

coderabbitai Bot mentioned this pull request Jun 5, 2026

Incorporate refined ORDERBOOK Call/Subscribe #44

Merged

coderabbitai Bot mentioned this pull request Jul 1, 2026

feat(withdraw): Binance travel-rule (localentity) withdrawal support #51

Merged

Navigation Menu

Uh oh!

Upgrade to v0.2.0 - #27

Upgrade to v0.2.0#27
rsoury merged 11 commits into
masterfrom
develop

rsoury commented Feb 19, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

Uh oh!

coderabbitai Bot commented Feb 19, 2026 •

edited

Loading

Review failed

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

rsoury commented Feb 19, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Release Notes

Uh oh!

Uh oh!

coderabbitai Bot commented Feb 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review failed

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Possibly related PRs

Suggested reviewers

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

rsoury commented Feb 19, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Feb 19, 2026 •

edited

Loading